Property Target Easing Timeline interpolates a property gradually from its old value to a new value using an easing curve each time a new value is set to the property.
More...
|
EasingFunction | getEasingFunction () const |
| Gets the easing function that defines the interpolation curve.
|
|
AnimationEasingMode | getEasingMode () const |
| Gets the easing mode that defines how to apply the easing function to the interpolation.
|
|
PropertyField | getInterpolatedPropertyField () const |
| Gets the property field whose value to interpolate.
|
|
AbstractPropertyType | getInterpolatedPropertyType () const |
| Gets the property type whose value to interpolate.
|
|
chrono::milliseconds | getInterpolationDuration () const |
| Gets the duration of the interpolation in milliseconds.
|
|
InterpolationIfInterruptedMode | getInterpolationIfInterruptedMode () const |
| Gets the mode of handling the interpolation if it is interrupted.
|
|
string | getObjectPath () const |
| Gets the path to the object whose property to interpolate.
|
|
void | setEasingFunction (EasingFunction easingFunction) |
| Sets the easing function that defines the interpolation curve.
|
|
void | setEasingMode (AnimationEasingMode easingMode) |
| Sets the easing mode that defines how to apply the easing function to the interpolation.
|
|
void | setInterpolationDuration (chrono::milliseconds interpolationDuration) |
| Sets the duration of the interpolation in milliseconds.
|
|
void | setInterpolationIfInterruptedMode (InterpolationIfInterruptedMode mode) |
| Sets the mode of handling the interpolation if it is interrupted.
|
|
TimeInterval | calculateClipInterval () |
| Calculates clip interval of timeline.
|
|
optional< chrono::milliseconds > | calculateDuration () |
| Calculates the duration of the timeline.
|
|
unsigned int | calculateIterationCount () |
| Calculates number of iterations in timeline.
|
|
optional< chrono::milliseconds > | calculateIterationDuration () |
| Calculates iteration duration.
|
|
TimelinePlaybackSharedPtr | createPlayback (TimelinePlaybackContext &context) |
| Creates playback for timeline.
|
|
optional< chrono::milliseconds > | getClipDuration () const |
| Gets the clip duration of the timeline (in milliseconds).
|
|
chrono::milliseconds | getClipStartTime () const |
| Gets the clip start time of the timeline (in milliseconds).
|
|
DirectionBehavior | getDirectionBehavior () const |
| Gets the direction behavior of a timeline.
|
|
float | getDurationScale () const |
| Gets the duration scale of timeline.
|
|
float | getMinimumDurationScale () const |
| Gets minimum duration scale.
|
|
unsigned int | getRepeatCount () const |
| Gets the repeat count of the timeline (zero indicates infinite repeats).
|
|
chrono::milliseconds | getStartTime () const |
| Gets the start time of the timeline (in milliseconds).
|
|
void | setClipDuration (optional< chrono::milliseconds > duration) |
| Sets the clip duration of the timeline (in milliseconds).
|
|
void | setClipStartTime (chrono::milliseconds clipStartTime) |
| Sets the clip start time of the timeline (in milliseconds).
|
|
void | setDirectionBehavior (DirectionBehavior directionBehavior) |
| Sets the direction behavior of a timeline.
|
|
void | setDurationScale (float scale) |
| Sets the duration scale of timeline.
|
|
void | setRepeatCount (unsigned int repeatCount) |
| Sets the repeat count of the timeline (zero indicates infinite repeats).
|
|
void | setStartTime (chrono::milliseconds startTime) |
| Gets the start time of the timeline (in milliseconds).
|
|
AppliedStyleEntrySharedPtr | applyObjectStyle (kanzi::StyleSharedPtr style) |
| Applies a style to an object.
|
|
void | applyObjectStyles () |
| Apply all styles for an object node.
|
|
Domain * | getDomain () const |
| Returns the domain the object belongs to.
|
|
const Metaclass * | getDynamicMetaclass () const override |
| Returns the metaclass of the dynamic type of the object.
|
|
MainLoopScheduler * | getMainLoopScheduler () const |
| Returns the MainLoopScheduler instance of the associated Domain.
|
|
detail::MessageDispatcher * | getMessageDispatcher () const |
| Returns the message dispatcher of the object.
|
|
ResourceManager * | getResourceManager () const |
| Returns the resource manager of the object.
|
|
ScriptingContextSharedPtr | getScriptingContext () const |
| Gets the scripting context of the object.
|
|
| Object (Domain *domain) |
|
void | setScriptingContext (ScriptingContextSharedPtr context) |
| Sets the scripting context of the object.
|
|
void | unapplyObjectStyle (AppliedStyleEntrySharedPtr appliedStyleEntry) |
|
void | unapplyObjectStyles () |
| Unapplies and removes all applied styles.
|
|
| ~Object () override |
|
bool | isTypeOf (const Metaclass *objectType) const |
| Determines if the type of this object is the given type or derived from it.
|
|
virtual | ~MetaObject () |
|
template<typename DataType > |
void | addPropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner) |
|
template<typename DataType > |
void | addPropertyModifierWithoutNotifyingHandlers (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner) |
| Adds a property modifier without notifying handlers.
|
|
template<typename DataType > |
void | addPropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner) |
|
template<typename DataType > |
void | addPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, PropertyValuePrecedence precedence, AbstractPropertyTypeDescriptor::ValueSourceOwner *owner) |
|
template<typename DataType > |
void | addPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, PropertyValuePrecedence precedence, void *ownerPointer) |
|
PropertyStorageContainer::iterator | beginPropertyStorage () |
| Returns the begin iterator to the internal property storage container.
|
|
PropertyStorageContainer::const_iterator | beginPropertyStorage () const |
| Returns the begin iterator to the internal property storage container.
|
|
void | clearPropertyFlag (AbstractPropertyType propertyType, uint32_t flag) |
|
void | copyLocalValue (const PropertyObject &other, AbstractPropertyType propertyType) |
| Copies local value of single property from another object.
|
|
void | copyLocalValues (const PropertyObject &other) |
| Copies all local values from another object.
|
|
PropertyStorageContainer::iterator | endPropertyStorage () |
| Returns the end iterator to the internal property storage container.
|
|
PropertyStorageContainer::const_iterator | endPropertyStorage () const |
| Returns the end iterator to the internal property storage container.
|
|
template<typename DataType > |
PropertyType< DataType >::Traits::ReturnType | getAbstractProperty (AbstractPropertyType abstractPropertyType) const |
|
template<typename DataType > |
PropertyType< DataType >::Traits::ReturnType | getAbstractPropertyBase (AbstractPropertyType abstractPropertyType) const |
|
template<typename DataType > |
optional< typename PropertyType< DataType >::Traits::ReturnType > | getOptionalAbstractProperty (AbstractPropertyType abstractPropertyType) const |
|
template<typename DataType > |
optional< typename PropertyType< DataType >::Traits::ReturnType > | getOptionalProperty (const PropertyType< DataType > &propertyType) const |
| Evaluates the property value in the same way as the overload above but does not default to the value in property metadata if there are no inputs to the property value.
|
|
template<typename DataType > |
optional< typename PropertyType< DataType >::Traits::ReturnType > | getOptionalPropertyBase (const PropertyType< DataType > &propertyType) const |
| Returns the current value of a property disregarding modifiers, but does not default to the value in property metadata if there are no inputs to the property value.
|
|
template<typename DataType > |
PropertyType< DataType >::Traits::ReturnType | getProperty (const PropertyType< DataType > &propertyType) const |
| Returns the current value of a property type.
|
|
template<typename DataType > |
PropertyType< DataType >::Traits::ReturnType | getPropertyBase (const PropertyType< DataType > &propertyType) const |
| Returns the current value of a property disregarding modifiers.
|
|
template<typename DataType > |
size_t | getPropertyNotificationHandlerCount (const PropertyType< DataType > &propertyType) const |
| Gets number of current notification handlers for given property type.
|
|
bool | hasBaseValue (AbstractPropertyType propertyType) const |
| Evaluates whether there are any inputs into the property value, disregarding modifiers.
|
|
bool | hasLocalValue (AbstractPropertyType propertyType) const |
| Evaluates whether there is a local value set for the property.
|
|
bool | hasNonClassValue (AbstractPropertyType propertyType) const |
| Evaluates whether there is a value of any precedence higher than class default value set for the property.
|
|
bool | hasValue (AbstractPropertyType propertyType) const |
| Evaluates whether there are any inputs into the property value.
|
|
bool | isPropertyFlagSet (AbstractPropertyType propertyType, uint32_t flag) const |
|
virtual void | onPropertyChanged (AbstractPropertyType propertyType, PropertyNotificationReason reason) |
| Virtual function to handle property change notifications.
|
|
| PropertyObject () |
|
void | removeKzbProperties () |
| Remove all KZB properties.
|
|
void | removeKzbProperties (flat_set< AbstractPropertyType > *keepProperties) |
| Remove all KZB properties that are not included in a given set.
|
|
template<typename DataType > |
void | removeLocalPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, void *ownerPointer) |
|
void | removeLocalValue (AbstractPropertyType propertyType) |
| Removes the local value associated with the property.
|
|
template<typename DataType > |
void | removePropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner) |
|
template<typename DataType > |
void | removePropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner) |
|
template<typename DataType > |
void | removePropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, void *ownerPointer) |
|
template<typename DataType > |
void | setAbstractProperty (AbstractPropertyType abstractPropertyType, typename PropertyType< DataType >::Traits::ParameterType value) |
|
template<typename DataType > |
void | setProperty (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Traits::ParameterType value) |
| Sets the local value of a property type.
|
|
void | setPropertyFlag (AbstractPropertyType propertyType, uint32_t flag) |
|
KZ_DEPRECATED void | validatePropertyModifiers (AbstractPropertyType propertyType) |
| Validates property modifiers and notifies handlers.
|
|
void | validatePropertyModifiersAndNotifyHandlers (AbstractPropertyType propertyType) |
| Validates property modifiers and notifies handlers.
|
|
virtual | ~PropertyObject () |
|
|
optional< chrono::milliseconds > | calculateContentDuration () override |
| Timeline::calculateContentDuration() implementation.
|
|
TimelinePlaybackSharedPtr | createPlaybackOverride (TimelinePlaybackContext &context) override |
| Timeline::createPlaybackOverride() implementation.
|
|
| PropertyTargetEasingTimeline (Domain *domain, string_view objectPath, AbstractPropertyType interpolatedPropertyType, PropertyField interpolatedPropertyField) |
| Constructor.
|
|
virtual void | loadOverride (Domain *domain, string_view name, KzbFile &kzbFile, KzbMemoryParser &parser) |
| Loads timeline data from KZB.
|
|
| Timeline (Domain *domain) |
| Constructor.
|
|
void | initialize () |
|
void | onCopy (const Object &other) |
|
void | initialize () |
|
| MetaObject () |
|
AbstractPropertyTypeDescriptor::ValueSourceEntry * | acquireLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, PropertyStoragePtr &propertyStorage) |
| Acquires a local value source entry that is free for the assignment of a value.
|
|
AbstractPropertyTypeDescriptor::ModifierStorage * | acquireModifierStorage (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage) |
|
AbstractPropertyTypeDescriptor::NotificationStorage * | acquireNotificationStorage (AbstractPropertyTypeDescriptor &descriptor) |
|
PropertyStoragePtr | acquirePropertyStorage (AbstractPropertyTypeDescriptor &descriptor) |
|
template<typename DataType > |
void | addPropertyModifierBase (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner, bool notify) |
| Adds a property modifier entry to the property modifier stack and validates them.
|
|
void | addPropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource *valueSource, PropertyValuePrecedence precedence, AbstractPropertyTypeDescriptor::ValueSourceOwner *owner) |
| Internally adds a property value source.
|
|
void | addPropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource *valueSource, PropertyValuePrecedence precedence, void *ownerPointer) |
| Internally adds a property value source.
|
|
AbstractPropertyTypeDescriptor::ValueSourceEntry * | constructLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage) |
|
PropertyStoragePtr | constructPropertyStorage (AbstractPropertyTypeDescriptor &descriptor) |
|
void | copyLocalValue (const AbstractPropertyTypeDescriptor::PropertyStorage &otherPropertyStorage) |
| Copy local value from property storage.
|
|
AbstractPropertyTypeDescriptor::ModifierStorage * | findModifierStorage (AbstractPropertyTypeDescriptor &descriptor) |
|
AbstractPropertyTypeDescriptor::NotificationStorage * | findNotificationStorage (AbstractPropertyTypeDescriptor &descriptor) const |
|
AbstractPropertyTypeDescriptor::PropertyStorage * | findPropertyStorage (AbstractPropertyTypeDescriptor &descriptor) const |
| Gets the property storage for given property type descriptor.
|
|
PropertyStoragePtr | findPropertyStoragePtr (AbstractPropertyTypeDescriptor &descriptor) const |
| Gets property storage intrusive pointer which you can use to hold a reference until the end of the operation.
|
|
AbstractPropertyTypeDescriptor * | findPropertyTypeDescriptorByNameAndDataType (string_view name, PropertyDataType dataType) const |
| Finds a property type descriptor by name and data type.
|
|
AbstractPropertyTypeDescriptor * | findPropertyTypeDescriptorByQualifiedNameAndDataType (string_view qualifiedName, PropertyDataType dataType) const |
| Like findPropertyTypeDescriptorByNameAndDataType, but only searches by matching with qualified names.
|
|
AbstractPropertyTypeDescriptor * | findPropertyTypeDescriptorByUnqualifiedNameAndDataType (string_view unqualifiedName, PropertyDataType dataType) const |
| Like findPropertyTypeDescriptorByNameAndDataType, but only searches by matching with unqualified names.
|
|
AbstractPropertyTypeDescriptor::ValueSource * | getClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const |
|
AbstractPropertyTypeDescriptor::ValueSource * | getFinalValueSource (AbstractPropertyTypeDescriptor &descriptor) const |
|
AbstractPropertyTypeDescriptor::ValueSource * | getNonClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const |
|
AbstractPropertyTypeDescriptor::ValueSource * | getTopValueSource (AbstractPropertyTypeDescriptor &descriptor) const |
| Gets the top-level value source for a given property descriptor.
|
|
virtual void | notifyPropertyHandlers (PropertyStoragePtr &storagePtr, PropertyNotificationReason reason) |
| Notifies all property handlers on a property storage.
|
|
void | onCopy (const PropertyObject &other) |
|
void | removeLocalValue (AbstractPropertyTypeDescriptor &descriptor, PropertyStoragePtr &propertyStorage) |
| Removes a local value from the given property storage.
|
|
void | removePropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource *valueSource, void *owner) |
| Removes a property value source.
|
|
void | validatePropertyModifiers (PropertyStoragePtr &propertyStorage) |
| Validates property modifiers without notifying handlers.
|
|
void | validatePropertyModifiersAndNotifyHandlers (PropertyStoragePtr &propertyStorage) |
| Validates property modifiers and notifies handlers.
|
|
Property Target Easing Timeline interpolates a property gradually from its old value to a new value using an easing curve each time a new value is set to the property.
The timeline interpolates a property of specified type on the object specified by its path.
Property Target Easing Timeline interpolates the property value using a from-to animation with an easing curve applied to it.
Note that setting time to playback of this timeline or advancing the timeline in reverse direction is not supported.
Examples
To create a property target easing timeline and set its target property and interpolation settings:
auto timeline = PropertyTargetEasingTimeline::create(domain, ".", Node2D::OpacityProperty, PropertyFieldWhole);
timeline->setInterpolationDuration(chrono::milliseconds(500));
timeline->setEasingFunction(LinearEasingFunction());
timeline->setEasingMode(AnimationEaseIn);
To create playback for property target easing timeline:
SceneGraphTimelinePlaybackContext context(*node);
auto playback = timeline->createPlayback(context);
To add playback of property target easing timeline to the clock:
domain->getRootTimelineClock()->addTimelinePlayback(playback);